home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / spitfire / sfchkup.zip / SFCHKUP.DOC < prev    next >
Text File  |  1992-01-02  |  11KB  |  214 lines
  1.                                 SFCHKUP
  2.                               Version 1.0
  3.                    Copyright (C) by Mike Woltz, 1991
  4.                          Buffalo Creek Software
  5.                               A Member Of 
  6.                 The Association Of Shareware Professionals
  7.     
  8.  
  9.     INTRODUCTION
  10.     ------------
  11.  
  12.        SFCHKUP is a utility which is designed to evaluate the integrity
  13.     of files uploaded by callers to a SPITFIRE BBS. It is utilized at
  14.     the beginning of the SFINIT.BAT file which is run immediately after
  15.     a caller logs off the BBS. Due to the fact that SFCHKUP is written
  16.     in Assembler, it takes up very little disk space and runs quickly.
  17.     
  18.  
  19.     REQUIRED FILES
  20.     --------------
  21.  
  22.        SFCHKUP.EXE is provided along with a sample batch file that is
  23.     used during processing. This file MUST be named CHKUP.BAT. A sample
  24.     SFCHKUP.MSG file is also provided which must reside in the SPITFIRE
  25.     Home Directory (if used). The use of this optional file is described
  26.     below. In addition, several other files are utilized during SFCHKUP
  27.     processing. These normally include MUV and DELXCEPT which are
  28.     available via Buffalo Creek's BBS (515-225-8496). Other files may
  29.     be used at the Sysop's discretion and depend upon the way their
  30.     CHKUP.BAT is set up.
  31.  
  32.  
  33.     CONFIGURATION OF SFCHKUP
  34.     ------------------------
  35.  
  36.        SFCHKUP.EXE and CHKUP.BAT must be placed in the SPITFIRE Home
  37.     Directory (which is where SPITFIRE.EXE is located.) To configure
  38.     SFCHKUP, just run it with no parameters. You will then be prompted
  39.     for the Upload File Path which is where uploads are stored once the
  40.     caller sends them. For this example, we will use C:\CHKUP1 as the
  41.     Upload File Path for Node 1. Each Node MUST have its own CHKUP
  42.     directory, normally named \CHKUP1, \CHKUP2, etc. This makes it
  43.     possible for SFCHKUP to run on a SPITFIRE BBS that has the maximum
  44.     number of nodes possible which is 255.
  45.         You will also be prompted for the File Area Path which is the
  46.     destination path of all files which successfully complete SFCHKUP's
  47.     evaluation. We will call this path C:\UPLOADS for our example.
  48.         Once these paths are provided, SFCHKUP will search the drives
  49.     configured to see if they exist. If not, SFCHKUP will create them.
  50.     You will then be prompted as to whether you wish to save changes.
  51.     Then, you're prompted as to whether you would like SFFAREA.DAT to be
  52.     refreshed. A [Y]es response will change the Upload File Path in ALL
  53.     areas of the node being configured to the CHKUP directory. A file
  54.     called SFCHKUP.DAT will store this information in the SPITFIRE Home
  55.     directory. Each node will have a unique SFCHKUP.DAT file.
  56.         If ever these paths need to be changed, run SFCHKUP /CONFIG and
  57.     you will once again be able to configure them.
  58.  
  59.  
  60.     CONFIGURATION OF CHKUP.BAT
  61.     --------------------------
  62.  
  63.         CHKUP.BAT contains a set of instructions that are carried out
  64.     during the proceedings of the use of SFCHKUP. It can run many other
  65.     programs and other batch files which will process uploaded files in
  66.     various ways. Since there is no way to know which ones will be used
  67.     by Sysops, they will not be discussed in detail here. Buffalo Creek
  68.     Software will not be responsible for their use or support.
  69.         A sample CHKUP.BAT is provided for you to use as an example when
  70.     you are setting up SFCHKUP.EXE. Examination of this batch file
  71.     reveals the use of other utilities during processing of uploads,
  72.     ways that certain uploads can avoid processing and the means to
  73.     dispose of particular uploads which do not evaluate properly.
  74.         It is necessary to edit CHKUP.BAT to your specifications. You
  75.     will need to configure the paths that it references for your system.
  76.     If you utilize any or all of the other programs referenced therein,
  77.     you will need to obtain them, configure them if necessary, and place
  78.     them in a subdirectory located in the path.
  79.         CHKUP.BAT normally creates a work directory (C:\CHKUP1\CHKWORK
  80.     for example) during processing and deletes it when its work is
  81.     complete. Uploaded files are moved there for evaluation, processed
  82.     there and then moved to another location afterwards.
  83.  
  84.  
  85.     RUNNING SFCHKUP
  86.     ---------------
  87.  
  88.         SFCHKUP is written to honor file sharing, and as such, may be
  89.     run on more than node of a multinode SPITFIRE BBS simultaneously.
  90.     Each node will require its own CHKUP path and its own CHKUP.BAT.
  91.     SFCHKUP is designed to be run at the BEGINNING of SFINIT.BAT,
  92.     especially on multinode SPITFIRE BBSs. This is because the first
  93.     thing that SFCHKUP does is check to see who the last caller was. If
  94.     SFCHKUP is run later on in SFINIT.BAT, and another node is running
  95.     it as well, it is possible that the information on last caller could
  96.     be incorrect. Take care to make sure to run SFCHKUP first!
  97.  
  98.         It is entirely up to you, the Sysop, how you utilize SFCHKUP
  99.     and its associated CHKUP.BAT file. You can make it as simple or as
  100.     elaborate as you please. Sysops who devise a unique methodology are
  101.     encouraged to share it with the rest of the SPITFIRE BBS community
  102.     by posting it in a message or uploading it to Buffalo Creek's BBS!
  103.  
  104.         A short discussion of suggested ways that files may be processed
  105.     follows. You are not required to process your files in the ways
  106.     described and you are free to run other tests in addition to or in
  107.     place of the ones described.
  108.  
  109.  
  110.  
  111.     EVALUATING FILES WITH CHKUP.BAT
  112.     -------------------------------
  113.  
  114.         In most cases, all files uploaded will be evaluated by SFCHKUP.
  115.     The phase of evaluation can be configured to be skipped if you'd
  116.     rather NOT process a file. You might want to post say *.TXT files
  117.     as is and feel that there is no need to perform any tests on them.
  118.     If this is the case, the example CHKUP.BAT file demonstrates how you
  119.     can check for this type file's existence (IF EXIST *.TXT...) and
  120.     then skip the processing entirely (...GOTO TXTFILE). The file would
  121.     then be posted exactly as it was uploaded to the BBS. Similarly, you
  122.     could elect not to process *.BBS/*.CLR files, etc.
  123.         You could configure CHKUP.BAT to check for files that you would
  124.     rather not be contained within the file such as known BBS ads,
  125.     PKUNZIP.EXE/PKZIP.EXE, COMMAND.COM, etc. By using a statement such
  126.     as IF EXIST <filename.ext> DEL <filename.ext>, these files can be
  127.     eliminated from the file. When SFCHKUP's work is done, it will
  128.     correctly update the SFFILES.BBS in the configured Upload File Path
  129.     with the file's FINAL size.
  130.         A utility designed to check for so-called Computer Viruses can
  131.     be run as part of the evaluation. In our example, McAfee's VIRUSCAN
  132.     is used. SCAN.EXE and similar utilities exit with a DOS ERRORLEVEL
  133.     based upon the results of the evaluation. Our CHKUP.BAT shows that
  134.     an errorlevel of 0 indicates a file with good integrity while a file
  135.     with an errorlevel of 1 indicates a questionable file. Questionable
  136.     files can be sent to a holding directory (ex. C:\BADCHKUP) for later
  137.     scrutiny (accomplished by two IF ERRORLEVEL...GOTO... statements)
  138.     or deleted entirely.
  139.         Another utility can be used to check uploaded *.GIF files. For
  140.     example, GIFTEST.EXE can be used. Since GIFTEST also exits with a
  141.     DOS ERRORLEVEL, careful editing of the CHKUP.BAT file can allow you
  142.     to delete the file if it has poor integrity or is at a resolution
  143.     that you do not support on your BBS or save it in the holding
  144.     directory. Here, we accept .GIF files of no less than 321x201x16
  145.     resolution.
  146.         ZIP Comments found in uploaded files can be removed and replaced
  147.     with that of your BBS after they have completed evaluation. There
  148.     are quite a number of recommenting utilities (ex. RECOM.EXE) that
  149.     can be used to accomplish this.
  150.         Files that have been compressed with schemes other than the one
  151.     you are using on your BBS can be converted (to PKZIP with a utility
  152.     such as TOZIP.EXE.) Remember that SPITFIRE will ONLY support online
  153.     viewing of the contents of files compressed with PKZIP, though!
  154.  
  155.         The above overview is brief by design. It is STRONGLY
  156.     recommended that you thoroughly read through the documentation of
  157.     each and every utility used in conjunction with SFCHKUP.
  158.  
  159.  
  160.     AFTER RUNNING SFCHKUP
  161.     ---------------------
  162.  
  163.         If files are not posted as a result of failing one of SFCHKUP's
  164.     integrity evaluation procedures, SFCHKUP will adjust the caller's
  165.     upload credits and K of upload credits accordingly subsequent to
  166.     completing evaluation of all files. In addition, SFCHKUP.MSG (which
  167.     must reside in the SPITFIRE HOME directory if used) will be copied
  168.     to XXX.BBS where XXX is the number of the caller who uploaded the
  169.     questionable file as contained in the SPITFIRE users database. The
  170.     filename will be appended to SFCHKUP.MSG. If there already exists a
  171.     XXX.BBS for that caller, SFCHKUP will append its data to it. In
  172.     addition, a notation is made to HEYSYSOP.LOG to notify the Sysop
  173.     that a questionable file has been received, its name and the name of
  174.     the caller who uploaded it.
  175.         All uploaded files with good integrity will then be moved to the
  176.     Upload File Area Path that you have configured. The SFFILES.BBS in
  177.     that area will be appended to with the final names, file sizes and
  178.     descriptions of all acceptable files. Finally, the work directory
  179.     will be removed and control will be returned to SFINIT.BAT.
  180.  
  181.  
  182.     DISTRIBUTION
  183.     ------------
  184.  
  185.        SFCHKUP is distributed under the shareware concept.  You are
  186.     free to distribute the SFCHKUP program as long as it remains
  187.     unmodified and no fee is charged.  If you continue to use this 
  188.     program after an adequate evaluation period, a fee is required.
  189.     A $1.00 registration fee is required to register SFCHKUP.  This
  190.     can be sent to:
  191.  
  192.                             Buffalo Creek Software
  193.                             ATTN: Mike Woltz
  194.                             913 39th Street
  195.                             West Des Moines, Iowa   50265
  196.  
  197.  
  198.     DISCLAIMER
  199.     ----------
  200.         
  201.        Mike Woltz and/or Buffalo Creek Software shall in no way be 
  202.     held responsible for any damage incurred while operating SFCHKUP.
  203.     All other programs used in conjunction with SFCHKUP are Copyright by
  204.     their respective authors and may not be products of Buffalo Creek
  205.     Software. All responsibility lies with the user of the software.
  206.  
  207.     The shareware version of SPITFIRE and other SPITFIRE utilities
  208.     are available for download from:
  209.  
  210.                             Buffalo Creek's BBS
  211.                              Mike Woltz, Sysop
  212.                               (515) 225-8496
  213.                        38400/19200/9600/2400/1200 Baud
  214.